Skip to content

Comments

Add "Getting started guide" and Headless Overview#330

Merged
jwittorf merged 17 commits intoTechdocsfrom
getting-started-guide-psn-and-headless
Dec 11, 2025
Merged

Add "Getting started guide" and Headless Overview#330
jwittorf merged 17 commits intoTechdocsfrom
getting-started-guide-psn-and-headless

Conversation

@jwittorf
Copy link

@jwittorf jwittorf commented Nov 19, 2025

https://nosto.slack.com/archives/C7S3D79GS/p1763546082059549

Review Status:

  • Getting Started Guide
  • PSN Overview
  • Headless Overview
  • Remove public email
  • Consider adding diagrams

SUMMARY.md Outdated
# Table of contents

* [Introduction](README.md)
## Getting started

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this section competes a bit with Implementing Nosto
is it a general intro section?
Also it is quite flat without any nesting

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey Timo, understand what you mean and I see there's some overlap but for now imo this is fine.

One main idea/background of the getting started guide is to use it in pre-sales. We want to set the expectations of the needed work and give a high level overview of what Nosto does etc., too often we had "mis-scopes" in the past. So we'd like to keep this guide separate from the main documentation to drive the narrative "read the full 'getting started guide' before our tech call".

How would you nest those pages? We tried to keep the structure as linear as possible, so as of now I can think of adding numbers for the menu to make this more clear, curious about your suggestions though, wdyt?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If it's pre-sales guide then it should be maybe named differently.
The whole "Implementing Nosto" section is also a getting started guide.

Copy link

@DJ-techie DJ-techie Nov 28, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe just a line at the very beginning of the section "Welcome & Support" that makes it clear that this is a guide which is meant for agencies that are implementing Nosto for clients.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want the first page of our docs to be the getting started/quick start guide. Readers (inhouse devs or agencies) have 0 context of Nosto and therefore need an overview of our docs and guidance through the different aspects of an implementation. They will read it in two situations:

  1. During pre-sales phase to make their estimate.
  2. When starting implementing Nosto (can be later down the road and can also be by a person that wasn't involved in the pre-sales discussion)

Of course, the details can vary and they are covered in the next "chapters" of the documentation.

I agree that there are certain aspects that are overlapping, imo the current "introduction" page can be deleted as it is getting replaced by the entire "getting started" chapter with the subpages and updated checklists rather than paragraphs.

What do you think of keeping the naming and removing https://github.com/Nosto/wiki-docs/blob/Techdocs/README.md (better said replacing it with https://github.com/Nosto/wiki-docs/blob/getting-started-guide-psn-and-headless/getting-started/README.md and maybe changing the headline "Welcome Guide")? @DJ-techie @timowestnosto

Copy link

@DJ-techie DJ-techie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"need to be available on all pages." I would suggest to make this bold!

Copilot AI added a commit that referenced this pull request Nov 28, 2025
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
Copilot AI added a commit that referenced this pull request Nov 28, 2025
Co-authored-by: timowestnosto <13622115+timowestnosto@users.noreply.github.com>
@jwittorf jwittorf changed the title Add "Getting started guide", PSN and Headless Overview Add "Getting started guide" and Headless Overview Dec 1, 2025
SUMMARY.md Outdated
# Table of contents

* [Introduction](README.md)
## Getting started
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We want the first page of our docs to be the getting started/quick start guide. Readers (inhouse devs or agencies) have 0 context of Nosto and therefore need an overview of our docs and guidance through the different aspects of an implementation. They will read it in two situations:

  1. During pre-sales phase to make their estimate.
  2. When starting implementing Nosto (can be later down the road and can also be by a person that wasn't involved in the pre-sales discussion)

Of course, the details can vary and they are covered in the next "chapters" of the documentation.

I agree that there are certain aspects that are overlapping, imo the current "introduction" page can be deleted as it is getting replaced by the entire "getting started" chapter with the subpages and updated checklists rather than paragraphs.

What do you think of keeping the naming and removing https://github.com/Nosto/wiki-docs/blob/Techdocs/README.md (better said replacing it with https://github.com/Nosto/wiki-docs/blob/getting-started-guide-psn-and-headless/getting-started/README.md and maybe changing the headline "Welcome Guide")? @DJ-techie @timowestnosto

* Techdocs:
  Fix links to other pages, prevent links to GitHub in GitBook
  Restructure Implementation section
  Update implementing-nosto/implement-psn/README.md
  Update SCM rate limit
  Update implementing-nosto/implement-psn/README.md
  Update implementing-nosto/implement-psn/README.md
  Update implementing-nosto/implement-on-your-website/advanced-implementation/adding-support-for-customer-group-pricing.md
  Remove agency-focused language and update title
  Initial plan
  Address review feedback: grammar, clarity, and examples
  Initial plan
  Exclude getting started additions

# Conflicts:
#	SUMMARY.md
#	getting-started/README.md
#	getting-started/building-your-implementation-plan.md
#	getting-started/headless-spa-frontend-implementation-methods.md
#	getting-started/how-to-get-the-most-out-of-our-guides-and-nosto.md
#	getting-started/what-nosto-does-and-how-it-works.md
#	implementing-nosto/implement-on-your-website/advanced-implementation/adding-support-for-customer-group-pricing.md
#	implementing-nosto/implement-psn/README.md
@jwittorf

This comment was marked as duplicate.

@jwittorf
Copy link
Author

jwittorf commented Dec 10, 2025

@timowestnosto @DJ-techie can I get a final review please? Everything should now be covered. I didn't get feedback on the headless part, can you please confirm this had been reviewed?

Browser view: https://docs.nosto.com/techdocs/~/revisions/tMt46jG8nursvLVj8vWv/

@jwittorf
Copy link
Author

Green light after Lucie reviewed the headless guide

@jwittorf jwittorf merged commit 94e1a0d into Techdocs Dec 11, 2025
2 checks passed
@jwittorf jwittorf deleted the getting-started-guide-psn-and-headless branch December 11, 2025 12:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants